/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_crypto_hal.h
 *
 * @brief 提供密码学操作的API。
 *
 * 根据这些API来实现加密和解密。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_crypto_hal.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef TEE_CRYPTO_HAL_H
#define TEE_CRYPTO_HAL_H

#include "tee_crypto_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 枚举加密引擎的类型。
 *
 * @since 20
 */
enum CRYPTO_ENGINE {
     /** 基于硬件的DX加密引擎。 */
    DX_CRYPTO = 0,
    /** 基于硬件的MSPE加密引擎。 */
    EPS_CRYPTO = 1,
    /** 基于软件的加密引擎，例如OpenSSL。 */
    SOFT_CRYPTO = 2,
    /** SEC加密引擎，常用于车载平台。 */
    SEC_CRYPTO = 3,
    /** 加密引擎的最大取值。 */
    CRYPTO_ENGINE_MAX = 1024,
};

/**
 * @brief 设置加密和解密引擎到操作中。
 *
 * @param operation [IN]指定操作的句柄。
 * @param crypto [IN]指定要设置的加密引擎。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：operation为null或crypto无效。
 * @since 20
 */
TEE_Result TEE_SetCryptoFlag(TEE_OperationHandle operation, uint32_t crypto);

/**
 * @brief 设置加密和解密引擎到对象中。
 *
 * @param object [IN]指定对象的句柄。
 * @param crypto [IN]指定要设置的加密引擎。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：operation为null或crypto无效。
 * @since 20
 */
TEE_Result TEE_SetObjectFlag(TEE_ObjectHandle object, uint32_t crypto);

#ifdef __cplusplus
}
#endif

#endif
/** @} */